<?php

/**
 * Maikuro Framework
 *
 * LICENSE:
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * The license is bundled with this package in the file LICENSE.txt.
 * You may also obtain a copy of the License at this URL:
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @copyright  Copyright (c) 2010, Jonathan Hedrén
 * @author     Jonathan Hedrén <jonathan.hedren@gmail.com>
 * @license    http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

class File extends SplFileInfo
{
    /**
     * The file extension
     *
     * @var string
     */
    private $extension;

    /**
     *
     * @param string $filename
     * @return File
     */
    public function  __construct($filename) {
        parent::__construct($filename);
        $this->extension = pathinfo($filename, PATHINFO_EXTENSION);
        return $this;
    }

    /**
     * Appends contents to the file.
     *
     * @param string $contents
     * @throws Exception
     * @return File
     */
    public function appendContents($contents)
    {
        if (!$this->isWritable()) {
            throw new Exception($this->getPathInfo() . ' is not writable.');
        }
        file_put_contents($this->getPathInfo(), $contents, FILE_APPEND);
        return $this;
    }

    /**
     * Returns the file extension.
     *
     * @return string
     */
    public function getExtension()
    {
        return $extension;
    }

    /**
     * Returns the file contents as a string.
     *
     * @return string
     */
    public function getContents()
    {
        if (!$this->isReadable()) {
            throw new Exception($this->getPathInfo() . ' is not readable.');
        }
        return file_get_contents($this->getPathInfo());
    }

    /**
     * Puts/writes the provided contents to the file.
     *
     * @param string $contents
     * @throws Exception
     * @return File
     */
    public function putContents($contents)
    {
        if (!$this->isWritable()) {
            throw new Exception($this->getPathInfo() . ' is not writable.');
        }
        file_put_contents($this->getPathInfo(), $contents);
        return $this;
    }
}